From: Timo Tijhof Date: Mon, 22 Apr 2013 12:31:04 +0000 (+0200) Subject: mediawiki.log: Add to jsduck index X-Git-Tag: 1.31.0-rc.0~19777^2 X-Git-Url: http://git.cyclocoop.org/%7D%7Cconcat%7B?a=commitdiff_plain;h=ca02a75cb4d496178d9a16fe5be4ac538ba1cf9d;p=lhc%2Fweb%2Fwiklou.git mediawiki.log: Add to jsduck index And fixing warnings as a result of it being in the index. Change-Id: I28dfc97d8fc63131fc02c0fa0f82945f3c18029f --- diff --git a/maintenance/jsduck/categories.json b/maintenance/jsduck/categories.json index c29c91c9b5..7e7b381b48 100644 --- a/maintenance/jsduck/categories.json +++ b/maintenance/jsduck/categories.json @@ -20,7 +20,7 @@ "mw.Title", "mw.notification", "mw.util", - "mw.plugin.notify" + "mw.plugin.*" ] }, { diff --git a/maintenance/jsduck/config.json b/maintenance/jsduck/config.json index e932b5c4b3..4ad75f00ff 100644 --- a/maintenance/jsduck/config.json +++ b/maintenance/jsduck/config.json @@ -9,6 +9,7 @@ "--": [ "./external.js", "../../resources/mediawiki/mediawiki.js", + "../../resources/mediawiki/mediawiki.log.js", "../../resources/mediawiki/mediawiki.util.js", "../../resources/mediawiki/mediawiki.Title.js", "../../resources/mediawiki/mediawiki.notify.js", diff --git a/resources/mediawiki/mediawiki.log.js b/resources/mediawiki/mediawiki.log.js index ee08b12bc6..e94f37ce4a 100644 --- a/resources/mediawiki/mediawiki.log.js +++ b/resources/mediawiki/mediawiki.log.js @@ -1,4 +1,4 @@ -/** +/*! * Logger for MediaWiki javascript. * Implements the stub left by the main 'mediawiki' module. * @@ -8,16 +8,20 @@ ( function ( mw, $ ) { + /** + * @class mw.plugin.log + */ + /** * Logs a message to the console. * * In the case the browser does not have a console API, a console is created on-the-fly by appending - * a
element to the bottom of the body and then appending this and future + * a `
` element to the bottom of the body and then appending this and future * messages to that, instead of the console. * - * @param {String} First in list of variadic messages to output to console. + * @param {string...} msg Messages to output to console. */ - mw.log = function ( /* logmsg, logmsg, */ ) { + mw.log = function () { // Turn arguments into an array var args = Array.prototype.slice.call( arguments ), // Allow log messages to use a configured prefix to identify the source window (ie. frame) @@ -68,4 +72,9 @@ } ); }; + /** + * @class mw + * @mixins mw.plugin.log + */ + }( mediaWiki, jQuery ) );